com.inscoper.nbo.OpticalCalibration

Represents the XML element OpticalCalibration. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	OpticalCalibration()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setDate(String value) Sets the value of the Date attribute.
String	getDate() Returns the value of the Date attribute.
void	setTheoreticalXYSpotSize_FWHM(float value) Sets the value of the TheoreticalXYSpotSize_FWHM attribute.
float	getTheoreticalXYSpotSize_FWHM() Returns the value of the TheoreticalXYSpotSize_FWHM attribute.
void	resetTheoreticalXYSpotSize_FWHM() Resets the TheoreticalXYSpotSize_FWHM attribute to an unset state.
boolean	hasTheoreticalXYSpotSize_FWHM() Checks whether the optional TheoreticalXYSpotSize_FWHM attribute is present.
void	setTheoreticalXYSpotSize_FWHMUnit(UnitsLength_Type value) Sets the value of the TheoreticalXYSpotSize_FWHMUnit attribute.
UnitsLength_Type	getTheoreticalXYSpotSize_FWHMUnit() Returns the value of the TheoreticalXYSpotSize_FWHMUnit attribute.
void	resetTheoreticalXYSpotSize_FWHMUnit() Resets the TheoreticalXYSpotSize_FWHMUnit attribute to an unset state.
boolean	hasTheoreticalXYSpotSize_FWHMUnit() Checks whether the optional TheoreticalXYSpotSize_FWHMUnit attribute is present.
void	setMedianXYSpotSize_FWHM(float value) Sets the value of the MedianXYSpotSize_FWHM attribute.
float	getMedianXYSpotSize_FWHM() Returns the value of the MedianXYSpotSize_FWHM attribute.
void	resetMedianXYSpotSize_FWHM() Resets the MedianXYSpotSize_FWHM attribute to an unset state.
boolean	hasMedianXYSpotSize_FWHM() Checks whether the optional MedianXYSpotSize_FWHM attribute is present.
void	setMedianXYSpotSize_FWHMUnit(UnitsLength_Type value) Sets the value of the MedianXYSpotSize_FWHMUnit attribute.
UnitsLength_Type	getMedianXYSpotSize_FWHMUnit() Returns the value of the MedianXYSpotSize_FWHMUnit attribute.
void	resetMedianXYSpotSize_FWHMUnit() Resets the MedianXYSpotSize_FWHMUnit attribute to an unset state.
boolean	hasMedianXYSpotSize_FWHMUnit() Checks whether the optional MedianXYSpotSize_FWHMUnit attribute is present.
void	setMinXYSpotSize_FWHM(float value) Sets the value of the MinXYSpotSize_FWHM attribute.
float	getMinXYSpotSize_FWHM() Returns the value of the MinXYSpotSize_FWHM attribute.
void	resetMinXYSpotSize_FWHM() Resets the MinXYSpotSize_FWHM attribute to an unset state.
boolean	hasMinXYSpotSize_FWHM() Checks whether the optional MinXYSpotSize_FWHM attribute is present.
void	setMinXYSpotSize_FWHMUnit(UnitsLength_Type value) Sets the value of the MinXYSpotSize_FWHMUnit attribute.
UnitsLength_Type	getMinXYSpotSize_FWHMUnit() Returns the value of the MinXYSpotSize_FWHMUnit attribute.
void	resetMinXYSpotSize_FWHMUnit() Resets the MinXYSpotSize_FWHMUnit attribute to an unset state.
boolean	hasMinXYSpotSize_FWHMUnit() Checks whether the optional MinXYSpotSize_FWHMUnit attribute is present.
void	setMaxXYSpotSize_FWHM(float value) Sets the value of the MaxXYSpotSize_FWHM attribute.
float	getMaxXYSpotSize_FWHM() Returns the value of the MaxXYSpotSize_FWHM attribute.
void	resetMaxXYSpotSize_FWHM() Resets the MaxXYSpotSize_FWHM attribute to an unset state.
boolean	hasMaxXYSpotSize_FWHM() Checks whether the optional MaxXYSpotSize_FWHM attribute is present.
void	setMaxXYSpotSize_FWHMUnit(float value) Sets the value of the MaxXYSpotSize_FWHMUnit attribute.
float	getMaxXYSpotSize_FWHMUnit() Returns the value of the MaxXYSpotSize_FWHMUnit attribute.
void	resetMaxXYSpotSize_FWHMUnit() Resets the MaxXYSpotSize_FWHMUnit attribute to an unset state.
boolean	hasMaxXYSpotSize_FWHMUnit() Checks whether the optional MaxXYSpotSize_FWHMUnit attribute is present.
void	setTheoreticaZSpotSize_FWHM(float value) Sets the value of the TheoreticaZSpotSize_FWHM attribute.
float	getTheoreticaZSpotSize_FWHM() Returns the value of the TheoreticaZSpotSize_FWHM attribute.
void	resetTheoreticaZSpotSize_FWHM() Resets the TheoreticaZSpotSize_FWHM attribute to an unset state.
boolean	hasTheoreticaZSpotSize_FWHM() Checks whether the optional TheoreticaZSpotSize_FWHM attribute is present.
void	setTheoreticaZSpotSize_FWHMUnit(UnitsLength_Type value) Sets the value of the TheoreticaZSpotSize_FWHMUnit attribute.
UnitsLength_Type	getTheoreticaZSpotSize_FWHMUnit() Returns the value of the TheoreticaZSpotSize_FWHMUnit attribute.
void	resetTheoreticaZSpotSize_FWHMUnit() Resets the TheoreticaZSpotSize_FWHMUnit attribute to an unset state.
boolean	hasTheoreticaZSpotSize_FWHMUnit() Checks whether the optional TheoreticaZSpotSize_FWHMUnit attribute is present.
void	setMedianZSpotSize_FWHM(float value) Sets the value of the MedianZSpotSize_FWHM attribute.
float	getMedianZSpotSize_FWHM() Returns the value of the MedianZSpotSize_FWHM attribute.
void	resetMedianZSpotSize_FWHM() Resets the MedianZSpotSize_FWHM attribute to an unset state.
boolean	hasMedianZSpotSize_FWHM() Checks whether the optional MedianZSpotSize_FWHM attribute is present.
void	setMedianZSpotSize_FWHMUnit(float value) Sets the value of the MedianZSpotSize_FWHMUnit attribute.
float	getMedianZSpotSize_FWHMUnit() Returns the value of the MedianZSpotSize_FWHMUnit attribute.
void	resetMedianZSpotSize_FWHMUnit() Resets the MedianZSpotSize_FWHMUnit attribute to an unset state.
boolean	hasMedianZSpotSize_FWHMUnit() Checks whether the optional MedianZSpotSize_FWHMUnit attribute is present.
void	setCheckedNA(boolean value) Sets the value of the CheckedNA attribute.
boolean	getCheckedNA() Returns the value of the CheckedNA attribute.
void	resetCheckedNA() Resets the CheckedNA attribute to an unset state.
boolean	hasCheckedNA() Checks whether the optional CheckedNA attribute is present.
void	setZ_Dimension(boolean value) Sets the value of the Z_Dimension attribute.
boolean	getZ_Dimension() Returns the value of the Z_Dimension attribute.
void	resetZ_Dimension() Resets the Z_Dimension attribute to an unset state.
boolean	hasZ_Dimension() Checks whether the optional Z_Dimension attribute is present.
void	setNyquistRate(float value) Sets the value of the NyquistRate attribute.
float	getNyquistRate() Returns the value of the NyquistRate attribute.
void	resetNyquistRate() Resets the NyquistRate attribute to an unset state.
boolean	hasNyquistRate() Checks whether the optional NyquistRate attribute is present.
void	setSampleSize(PositiveInt_Type value) Sets the value of the SampleSize attribute.
PositiveInt_Type	getSampleSize() Returns the value of the SampleSize attribute.
void	resetSampleSize() Resets the SampleSize attribute to an unset state.
boolean	hasSampleSize() Checks whether the optional SampleSize attribute is present.
void	setPSFEquation(String value) Sets the value of the PSFEquation attribute.
String	getPSFEquation() Returns the value of the PSFEquation attribute.
void	resetPSFEquation() Resets the PSFEquation attribute to an unset state.
boolean	hasPSFEquation() Checks whether the optional PSFEquation attribute is present.
void	setPlanarity(float value) Sets the value of the Planarity attribute.
float	getPlanarity() Returns the value of the Planarity attribute.
void	resetPlanarity() Resets the Planarity attribute to an unset state.
boolean	hasPlanarity() Checks whether the optional Planarity attribute is present.
void	setPlanarityUnit(UnitsLength_Type value) Sets the value of the PlanarityUnit attribute.
UnitsLength_Type	getPlanarityUnit() Returns the value of the PlanarityUnit attribute.
void	resetPlanarityUnit() Resets the PlanarityUnit attribute to an unset state.
boolean	hasPlanarityUnit() Checks whether the optional PlanarityUnit attribute is present.
void	setLateralAsymmetry(float value) Sets the value of the LateralAsymmetry attribute.
float	getLateralAsymmetry() Returns the value of the LateralAsymmetry attribute.
void	resetLateralAsymmetry() Resets the LateralAsymmetry attribute to an unset state.
boolean	hasLateralAsymmetry() Checks whether the optional LateralAsymmetry attribute is present.
void	setAxialAsymmetry(float value) Sets the value of the AxialAsymmetry attribute.
float	getAxialAsymmetry() Returns the value of the AxialAsymmetry attribute.
void	resetAxialAsymmetry() Resets the AxialAsymmetry attribute to an unset state.
boolean	hasAxialAsymmetry() Checks whether the optional AxialAsymmetry attribute is present.
void	setOpticalCalibrationImageRef_List(OpticalCalibrationImageRefVector value) Sets the list of OpticalCalibrationImageRef elements.
OpticalCalibrationImageRefVector	getOpticalCalibrationImageRef_List() Returns the list of OpticalCalibrationImageRef elements.
void	addToOpticalCalibrationImageRef_List(OpticalCalibrationImageRef value) Adds a new OpticalCalibrationImageRef element to this object.
void	clearOpticalCalibrationImageRef_List() Clear the list of OpticalCalibrationImageRef.
void	setPSFEquationFile_List(FileAnnotation_TypeVector value) Sets the list of PSFEquationFile elements.
FileAnnotation_TypeVector	getPSFEquationFile_List() Returns the list of PSFEquationFile elements.
void	addToPSFEquationFile_List(FileAnnotation_Type value) Adds a new PSFEquationFile element to this object.
void	clearPSFEquationFile_List() Clear the list of PSFEquationFile.
void	setOpticalCalibrationReport_List(FileAnnotation_TypeVector value) Sets the list of OpticalCalibrationReport elements.
FileAnnotation_TypeVector	getOpticalCalibrationReport_List() Returns the list of OpticalCalibrationReport elements.
void	addToOpticalCalibrationReport_List(FileAnnotation_Type value) Adds a new OpticalCalibrationReport element to this object.
void	clearOpticalCalibrationReport_List() Clear the list of OpticalCalibrationReport.
void	setChromaticRegistrationEvaluation_List(ChromaticRegistrationEvaluationVector value) Sets the list of ChromaticRegistrationEvaluation elements.
ChromaticRegistrationEvaluationVector	getChromaticRegistrationEvaluation_List() Returns the list of ChromaticRegistrationEvaluation elements.
void	addToChromaticRegistrationEvaluation_List(ChromaticRegistrationEvaluation value) Adds a new ChromaticRegistrationEvaluation element to this object.
void	clearChromaticRegistrationEvaluation_List() Clear the list of ChromaticRegistrationEvaluation.
void	setFieldUniformityEvaluation_List(FieldUniformityEvaluationVector value) Sets the list of FieldUniformityEvaluation elements.
FieldUniformityEvaluationVector	getFieldUniformityEvaluation_List() Returns the list of FieldUniformityEvaluation elements.
void	addToFieldUniformityEvaluation_List(FieldUniformityEvaluation value) Adds a new FieldUniformityEvaluation element to this object.
void	clearFieldUniformityEvaluation_List() Clear the list of FieldUniformityEvaluation.
void	setOpticalCalibrationStandardGroup_List(OpticalCalibrationStandard_TypeVector value) Sets the list of OpticalCalibrationStandardGroup elements.
OpticalCalibrationStandard_TypeVector	getOpticalCalibrationStandardGroup_List() Returns the list of OpticalCalibrationStandardGroup elements.
void	addToOpticalCalibrationStandardGroup_List(OpticalCalibrationStandard_Type value) Adds a new OpticalCalibrationStandardGroup element to this object.
void	clearOpticalCalibrationStandardGroup_List() Clear the list of OpticalCalibrationStandardGroup.
void	setCalibrationSoftware_List(CalibrationSoftwareVector value) Sets the list of CalibrationSoftware elements.
CalibrationSoftwareVector	getCalibrationSoftware_List() Returns the list of CalibrationSoftware elements.
void	addToCalibrationSoftware_List(CalibrationSoftware value) Adds a new CalibrationSoftware element to this object.
void	clearCalibrationSoftware_List() Clear the list of CalibrationSoftware.
void	setAnnotationRef(OpticalCalibration_InlineAnnotationRef value) Sets the value of the AnnotationRef element.
OpticalCalibration_InlineAnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
OpticalCalibration	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	OpticalCalibration(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(OpticalCalibration obj)

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.OpticalCalibration;

Represents the XML element OpticalCalibration.

This describes the procedure that was used for Optical Calibration and the resulting Calibration measurements.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function OpticalCalibration

public OpticalCalibration()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    LSID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID

public LSID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A Unique Identifier for this component.

function setDate

public void setDate(
    String value
)

Sets the value of the Date attribute.

Parameters:

value The value to set

Ths field records the Date in which this Calibration procedure was performed.

function getDate

public String getDate()

Returns the value of the Date attribute.

Return: The value of the attribute

Ths field records the Date in which this Calibration procedure was performed.

function setTheoreticalXYSpotSize_FWHM

public void setTheoreticalXYSpotSize_FWHM(
    float value
)

Sets the value of the TheoreticalXYSpotSize_FWHM attribute.

Parameters:

value The value to set

This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.

function getTheoreticalXYSpotSize_FWHM

public float getTheoreticalXYSpotSize_FWHM()

Returns the value of the TheoreticalXYSpotSize_FWHM attribute.

Return: The value of the attribute

This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.

function resetTheoreticalXYSpotSize_FWHM

public void resetTheoreticalXYSpotSize_FWHM()

Resets the TheoreticalXYSpotSize_FWHM attribute to an unset state.

This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.

function hasTheoreticalXYSpotSize_FWHM

public boolean hasTheoreticalXYSpotSize_FWHM()

Checks whether the optional TheoreticalXYSpotSize_FWHM attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the Theoretical (expected) lateral spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the xy-plane. This value should be calculated in a manner as to be compared to the Median XY Spot Size_FWHM.

function setTheoreticalXYSpotSize_FWHMUnit

public void setTheoreticalXYSpotSize_FWHMUnit(
    UnitsLength_Type value
)

Sets the value of the TheoreticalXYSpotSize_FWHMUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTheoreticalXYSpotSize_FWHMUnit

public UnitsLength_Type getTheoreticalXYSpotSize_FWHMUnit()

Returns the value of the TheoreticalXYSpotSize_FWHMUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTheoreticalXYSpotSize_FWHMUnit

public void resetTheoreticalXYSpotSize_FWHMUnit()

Resets the TheoreticalXYSpotSize_FWHMUnit attribute to an unset state.

No description available in the XSD standard.

function hasTheoreticalXYSpotSize_FWHMUnit

public boolean hasTheoreticalXYSpotSize_FWHMUnit()

Checks whether the optional TheoreticalXYSpotSize_FWHMUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMedianXYSpotSize_FWHM

public void setMedianXYSpotSize_FWHM(
    float value
)

Sets the value of the MedianXYSpotSize_FWHM attribute.

Parameters:

value The value to set

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getMedianXYSpotSize_FWHM

public float getMedianXYSpotSize_FWHM()

Returns the value of the MedianXYSpotSize_FWHM attribute.

Return: The value of the attribute

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetMedianXYSpotSize_FWHM

public void resetMedianXYSpotSize_FWHM()

Resets the MedianXYSpotSize_FWHM attribute to an unset state.

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasMedianXYSpotSize_FWHM

public boolean hasMedianXYSpotSize_FWHM()

Checks whether the optional MedianXYSpotSize_FWHM attribute is present.

Return: true if the optional attribute has been set, false otherwise

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setMedianXYSpotSize_FWHMUnit

public void setMedianXYSpotSize_FWHMUnit(
    UnitsLength_Type value
)

Sets the value of the MedianXYSpotSize_FWHMUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMedianXYSpotSize_FWHMUnit

public UnitsLength_Type getMedianXYSpotSize_FWHMUnit()

Returns the value of the MedianXYSpotSize_FWHMUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMedianXYSpotSize_FWHMUnit

public void resetMedianXYSpotSize_FWHMUnit()

Resets the MedianXYSpotSize_FWHMUnit attribute to an unset state.

No description available in the XSD standard.

function hasMedianXYSpotSize_FWHMUnit

public boolean hasMedianXYSpotSize_FWHMUnit()

Checks whether the optional MedianXYSpotSize_FWHMUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMinXYSpotSize_FWHM

public void setMinXYSpotSize_FWHM(
    float value
)

Sets the value of the MinXYSpotSize_FWHM attribute.

Parameters:

value The value to set

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getMinXYSpotSize_FWHM

public float getMinXYSpotSize_FWHM()

Returns the value of the MinXYSpotSize_FWHM attribute.

Return: The value of the attribute

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetMinXYSpotSize_FWHM

public void resetMinXYSpotSize_FWHM()

Resets the MinXYSpotSize_FWHM attribute to an unset state.

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasMinXYSpotSize_FWHM

public boolean hasMinXYSpotSize_FWHM()

Checks whether the optional MinXYSpotSize_FWHM attribute is present.

Return: true if the optional attribute has been set, false otherwise

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Minimum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setMinXYSpotSize_FWHMUnit

public void setMinXYSpotSize_FWHMUnit(
    UnitsLength_Type value
)

Sets the value of the MinXYSpotSize_FWHMUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMinXYSpotSize_FWHMUnit

public UnitsLength_Type getMinXYSpotSize_FWHMUnit()

Returns the value of the MinXYSpotSize_FWHMUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMinXYSpotSize_FWHMUnit

public void resetMinXYSpotSize_FWHMUnit()

Resets the MinXYSpotSize_FWHMUnit attribute to an unset state.

No description available in the XSD standard.

function hasMinXYSpotSize_FWHMUnit

public boolean hasMinXYSpotSize_FWHMUnit()

Checks whether the optional MinXYSpotSize_FWHMUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMaxXYSpotSize_FWHM

public void setMaxXYSpotSize_FWHM(
    float value
)

Sets the value of the MaxXYSpotSize_FWHM attribute.

Parameters:

value The value to set

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getMaxXYSpotSize_FWHM

public float getMaxXYSpotSize_FWHM()

Returns the value of the MaxXYSpotSize_FWHM attribute.

Return: The value of the attribute

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetMaxXYSpotSize_FWHM

public void resetMaxXYSpotSize_FWHM()

Resets the MaxXYSpotSize_FWHM attribute to an unset state.

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasMaxXYSpotSize_FWHM

public boolean hasMaxXYSpotSize_FWHM()

Checks whether the optional MaxXYSpotSize_FWHM attribute is present.

Return: true if the optional attribute has been set, false otherwise

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, lateral Resolution is defined by the FWHM of the intensity signal along a lateral direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Maximum lateral (i.e., in the xy-plane) Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setMaxXYSpotSize_FWHMUnit

public void setMaxXYSpotSize_FWHMUnit(
    float value
)

Sets the value of the MaxXYSpotSize_FWHMUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMaxXYSpotSize_FWHMUnit

public float getMaxXYSpotSize_FWHMUnit()

Returns the value of the MaxXYSpotSize_FWHMUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMaxXYSpotSize_FWHMUnit

public void resetMaxXYSpotSize_FWHMUnit()

Resets the MaxXYSpotSize_FWHMUnit attribute to an unset state.

No description available in the XSD standard.

function hasMaxXYSpotSize_FWHMUnit

public boolean hasMaxXYSpotSize_FWHMUnit()

Checks whether the optional MaxXYSpotSize_FWHMUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setTheoreticaZSpotSize_FWHM

public void setTheoreticaZSpotSize_FWHM(
    float value
)

Sets the value of the TheoreticaZSpotSize_FWHM attribute.

Parameters:

value The value to set

This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.

function getTheoreticaZSpotSize_FWHM

public float getTheoreticaZSpotSize_FWHM()

Returns the value of the TheoreticaZSpotSize_FWHM attribute.

Return: The value of the attribute

This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.

function resetTheoreticaZSpotSize_FWHM

public void resetTheoreticaZSpotSize_FWHM()

Resets the TheoreticaZSpotSize_FWHM attribute to an unset state.

This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.

function hasTheoreticaZSpotSize_FWHM

public boolean hasTheoreticaZSpotSize_FWHM()

Checks whether the optional TheoreticaZSpotSize_FWHM attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the Theoretical (expected) z-axial spot size expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using a Gaussian function, on the basis of the given optical conditions. This is a measure of the expected resolution of the system in the z-plane. This value should be used calculated in a manner as to be compared to the median Z spot size.

function setTheoreticaZSpotSize_FWHMUnit

public void setTheoreticaZSpotSize_FWHMUnit(
    UnitsLength_Type value
)

Sets the value of the TheoreticaZSpotSize_FWHMUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTheoreticaZSpotSize_FWHMUnit

public UnitsLength_Type getTheoreticaZSpotSize_FWHMUnit()

Returns the value of the TheoreticaZSpotSize_FWHMUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTheoreticaZSpotSize_FWHMUnit

public void resetTheoreticaZSpotSize_FWHMUnit()

Resets the TheoreticaZSpotSize_FWHMUnit attribute to an unset state.

No description available in the XSD standard.

function hasTheoreticaZSpotSize_FWHMUnit

public boolean hasTheoreticaZSpotSize_FWHMUnit()

Checks whether the optional TheoreticaZSpotSize_FWHMUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMedianZSpotSize_FWHM

public void setMedianZSpotSize_FWHM(
    float value
)

Sets the value of the MedianZSpotSize_FWHM attribute.

Parameters:

value The value to set

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getMedianZSpotSize_FWHM

public float getMedianZSpotSize_FWHM()

Returns the value of the MedianZSpotSize_FWHM attribute.

Return: The value of the attribute

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetMedianZSpotSize_FWHM

public void resetMedianZSpotSize_FWHM()

Resets the MedianZSpotSize_FWHM attribute to an unset state.

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasMedianZSpotSize_FWHM

public boolean hasMedianZSpotSize_FWHM()

Checks whether the optional MedianZSpotSize_FWHM attribute is present.

Return: true if the optional attribute has been set, false otherwise

An important way of evaluating the effective resolution of any Microscope, consists in measuring the size and shape of the observed Point Spread Function (PSF) generated by imaging one or more fluorescent Point-like objects (i.e., Point Emitters) under conditions that are identical to those used to Acquire a given experimental Image. More specifically and according to ISO 21073:2019, axial Resolution is defined by the FWHM of the intensity signal along the axial direction through the centre of a fluorescent Point-like object (i.e., Spot or Point Emitter) positioned at the center of the Field of View (FOV). This field captures the average Observed Median Z-axial Spot Sze expressed as the Full Width at Half Maximum (FWHM) of the Point Spread Function (PSF) intensity profile fitted using an Elliptic Gaussian function. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setMedianZSpotSize_FWHMUnit

public void setMedianZSpotSize_FWHMUnit(
    float value
)

Sets the value of the MedianZSpotSize_FWHMUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMedianZSpotSize_FWHMUnit

public float getMedianZSpotSize_FWHMUnit()

Returns the value of the MedianZSpotSize_FWHMUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMedianZSpotSize_FWHMUnit

public void resetMedianZSpotSize_FWHMUnit()

Resets the MedianZSpotSize_FWHMUnit attribute to an unset state.

No description available in the XSD standard.

function hasMedianZSpotSize_FWHMUnit

public boolean hasMedianZSpotSize_FWHMUnit()

Checks whether the optional MedianZSpotSize_FWHMUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setCheckedNA

public void setCheckedNA(
    boolean value
)

Sets the value of the CheckedNA attribute.

Parameters:

value The value to set

In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.

function getCheckedNA

public boolean getCheckedNA()

Returns the value of the CheckedNA attribute.

Return: The value of the attribute

In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.

function resetCheckedNA

public void resetCheckedNA()

Resets the CheckedNA attribute to an unset state.

In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.

function hasCheckedNA

public boolean hasCheckedNA()

Checks whether the optional CheckedNA attribute is present.

Return: true if the optional attribute has been set, false otherwise

In case the Numerical Aperture (NA) of the Objective utilized to perform this Optical Calibration is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture whether (True) or not (False) a manual check was performed to confirm that the Numerical Aperture was set to the Maximum allowable value. This check is necessary because often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments. In this context, setting the collar to the Maximum NA position is desirable not only because it is more easy to reproduce and it best to estimate the maximal resolution of the system.

function setZ_Dimension

public void setZ_Dimension(
    boolean value
)

Sets the value of the Z_Dimension attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.

function getZ_Dimension

public boolean getZ_Dimension()

Returns the value of the Z_Dimension attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.

function resetZ_Dimension

public void resetZ_Dimension()

Resets the Z_Dimension attribute to an unset state.

This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.

function hasZ_Dimension

public boolean hasZ_Dimension()

Checks whether the optional Z_Dimension attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records whether (True) or not (False) this Optical Calibration procedure was performed using XY or XYZ Images of the Optical Standard sample.

function setNyquistRate

public void setNyquistRate(
    float value
)

Sets the value of the NyquistRate attribute.

Parameters:

value The value to set

This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.

function getNyquistRate

public float getNyquistRate()

Returns the value of the NyquistRate attribute.

Return: The value of the attribute

This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.

function resetNyquistRate

public void resetNyquistRate()

Resets the NyquistRate attribute to an unset state.

This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.

function hasNyquistRate

public boolean hasNyquistRate()

Checks whether the optional NyquistRate attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the ratio between the Pixel Size and the Nyquist Criterion. The Nyquist-Shannon sampling theorem establishes that 'when sampling a signal (e.g., converting from an analog signal to digital), the sampling frequency must be greater than twice the Band Width of the input signal in order to be able to reconstruct the original perfectly from the sampled version' (Whittaker E.T., (1915). Proc. Roy. Soc. Edinburgh Sect. A, 25:181; Shannon C.E., (1949) Proc. IRE, 37:10). The Nyquist Criterion determines the minimal Sampling Density needed to capture ALL information from the Specimen into the Image. It can be shown that if the Sampling Density is higher than the Nyquist Rate (also referred to as Critical Sampling Distance) all information about the object is captured. It is important to note that the Nyquist Rate depends on the Objective Numerical Aperture (NA) and on the Excitation and Emission WaveLengths. The recommended Nyquist Rate is > 2 for conventional light microscopy, and it is 2.5 - 3 for high resolution imaging.

function setSampleSize

public void setSampleSize(
    PositiveInt_Type value
)

Sets the value of the SampleSize attribute.

Parameters:

value The value to set

This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.

function getSampleSize

public PositiveInt_Type getSampleSize()

Returns the value of the SampleSize attribute.

Return: The value of the attribute

This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.

function resetSampleSize

public void resetSampleSize()

Resets the SampleSize attribute to an unset state.

This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.

function hasSampleSize

public boolean hasSampleSize()

Checks whether the optional SampleSize attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the Sample size that was used to calculate the reported Optical Calibration metrics. For example, this might represent the number of Colored Beads that were utilized to gather data on the Optical performance of the Microscope.

function setPSFEquation

public void setPSFEquation(
    String value
)

Sets the value of the PSFEquation attribute.

Parameters:

value The value to set

This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.

function getPSFEquation

public String getPSFEquation()

Returns the value of the PSFEquation attribute.

Return: The value of the attribute

This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.

function resetPSFEquation

public void resetPSFEquation()

Resets the PSFEquation attribute to an unset state.

This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.

function hasPSFEquation

public boolean hasPSFEquation()

Checks whether the optional PSFEquation attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field captures the Equation that was used to perform the Eliptical PSF Gaussian Fit.

function setPlanarity

public void setPlanarity(
    float value
)

Sets the value of the Planarity attribute.

Parameters:

value The value to set

This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getPlanarity

public float getPlanarity()

Returns the value of the Planarity attribute.

Return: The value of the attribute

This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetPlanarity

public void resetPlanarity()

Resets the Planarity attribute to an unset state.

This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasPlanarity

public boolean hasPlanarity()

Checks whether the optional Planarity attribute is present.

Return: true if the optional attribute has been set, false otherwise

This is a measure of the flatness of the focal plane across the Field of View (FOV). The planarity of the focal plane is calculated from the observed z-position of the best focus of each Point Emitter. It indicates focal aberrations or tilt. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setPlanarityUnit

public void setPlanarityUnit(
    UnitsLength_Type value
)

Sets the value of the PlanarityUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPlanarityUnit

public UnitsLength_Type getPlanarityUnit()

Returns the value of the PlanarityUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPlanarityUnit

public void resetPlanarityUnit()

Resets the PlanarityUnit attribute to an unset state.

No description available in the XSD standard.

function hasPlanarityUnit

public boolean hasPlanarityUnit()

Checks whether the optional PlanarityUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setLateralAsymmetry

public void setLateralAsymmetry(
    float value
)

Sets the value of the LateralAsymmetry attribute.

Parameters:

value The value to set

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getLateralAsymmetry

public float getLateralAsymmetry()

Returns the value of the LateralAsymmetry attribute.

Return: The value of the attribute

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetLateralAsymmetry

public void resetLateralAsymmetry()

Resets the LateralAsymmetry attribute to an unset state.

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasLateralAsymmetry

public boolean hasLateralAsymmetry()

Checks whether the optional LateralAsymmetry attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Lateral Asymmetry (i.e. the ratio of the minimum lateral FWMH over the maximum lateral FWHM). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setAxialAsymmetry

public void setAxialAsymmetry(
    float value
)

Sets the value of the AxialAsymmetry attribute.

Parameters:

value The value to set

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function getAxialAsymmetry

public float getAxialAsymmetry()

Returns the value of the AxialAsymmetry attribute.

Return: The value of the attribute

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function resetAxialAsymmetry

public void resetAxialAsymmetry()

Resets the AxialAsymmetry attribute to an unset state.

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function hasAxialAsymmetry

public boolean hasAxialAsymmetry()

Checks whether the optional AxialAsymmetry attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field reports the mean +/- standard deviation over the Field of View (FOV) of the observed Point Spread Function (PSF) Axial Asymmetry (i.e. the ratio of the minimum axial FWMH over the maximum axial FWHM; also referred to as Spherical Aberration). It indicates the presence of optical aberrations. Ideally this measurement should be reflective of multiple individual Point Emitter observations across the Field of View (FOV). However, if a single measurement is taken, it is essential that this be taken from the center of the Objective FOV.

function setOpticalCalibrationImageRef_List

public void setOpticalCalibrationImageRef_List(
    OpticalCalibrationImageRefVector value
)

Sets the list of OpticalCalibrationImageRef elements.

Parameters:

value The new list of OpticalCalibrationImageRef elements

No description available in the XSD standard.

function getOpticalCalibrationImageRef_List

public OpticalCalibrationImageRefVector getOpticalCalibrationImageRef_List()

Returns the list of OpticalCalibrationImageRef elements.

Return: The list of OpticalCalibrationImageRef elements

No description available in the XSD standard.

function addToOpticalCalibrationImageRef_List

public void addToOpticalCalibrationImageRef_List(
    OpticalCalibrationImageRef value
)

Adds a new OpticalCalibrationImageRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearOpticalCalibrationImageRef_List

public void clearOpticalCalibrationImageRef_List()

Clear the list of OpticalCalibrationImageRef.

No description available in the XSD standard.

function setPSFEquationFile_List

public void setPSFEquationFile_List(
    FileAnnotation_TypeVector value
)

Sets the list of PSFEquationFile elements.

Parameters:

value The new list of PSFEquationFile elements

This element refers to any type of file describing the PSF Equation that was used in this case.

function getPSFEquationFile_List

public FileAnnotation_TypeVector getPSFEquationFile_List()

Returns the list of PSFEquationFile elements.

Return: The list of PSFEquationFile elements

This element refers to any type of file describing the PSF Equation that was used in this case.

function addToPSFEquationFile_List

public void addToPSFEquationFile_List(
    FileAnnotation_Type value
)

Adds a new PSFEquationFile element to this object.

Parameters:

value The element to add

This element refers to any type of file describing the PSF Equation that was used in this case.

function clearPSFEquationFile_List

public void clearPSFEquationFile_List()

Clear the list of PSFEquationFile.

This element refers to any type of file describing the PSF Equation that was used in this case.

function setOpticalCalibrationReport_List

public void setOpticalCalibrationReport_List(
    FileAnnotation_TypeVector value
)

Sets the list of OpticalCalibrationReport elements.

Parameters:

value The new list of OpticalCalibrationReport elements

This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.

function getOpticalCalibrationReport_List

public FileAnnotation_TypeVector getOpticalCalibrationReport_List()

Returns the list of OpticalCalibrationReport elements.

Return: The list of OpticalCalibrationReport elements

This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.

function addToOpticalCalibrationReport_List

public void addToOpticalCalibrationReport_List(
    FileAnnotation_Type value
)

Adds a new OpticalCalibrationReport element to this object.

Parameters:

value The element to add

This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.

function clearOpticalCalibrationReport_List

public void clearOpticalCalibrationReport_List()

Clear the list of OpticalCalibrationReport.

This element refers to any File containing a report generated by the Calibration Software referred to in Calibration procedure.

function setChromaticRegistrationEvaluation_List

public void setChromaticRegistrationEvaluation_List(
    ChromaticRegistrationEvaluationVector value
)

Sets the list of ChromaticRegistrationEvaluation elements.

Parameters:

value The new list of ChromaticRegistrationEvaluation elements

No description available in the XSD standard.

function getChromaticRegistrationEvaluation_List

public ChromaticRegistrationEvaluationVector getChromaticRegistrationEvaluation_List()

Returns the list of ChromaticRegistrationEvaluation elements.

Return: The list of ChromaticRegistrationEvaluation elements

No description available in the XSD standard.

function addToChromaticRegistrationEvaluation_List

public void addToChromaticRegistrationEvaluation_List(
    ChromaticRegistrationEvaluation value
)

Adds a new ChromaticRegistrationEvaluation element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearChromaticRegistrationEvaluation_List

public void clearChromaticRegistrationEvaluation_List()

Clear the list of ChromaticRegistrationEvaluation.

No description available in the XSD standard.

function setFieldUniformityEvaluation_List

public void setFieldUniformityEvaluation_List(
    FieldUniformityEvaluationVector value
)

Sets the list of FieldUniformityEvaluation elements.

Parameters:

value The new list of FieldUniformityEvaluation elements

No description available in the XSD standard.

function getFieldUniformityEvaluation_List

public FieldUniformityEvaluationVector getFieldUniformityEvaluation_List()

Returns the list of FieldUniformityEvaluation elements.

Return: The list of FieldUniformityEvaluation elements

No description available in the XSD standard.

function addToFieldUniformityEvaluation_List

public void addToFieldUniformityEvaluation_List(
    FieldUniformityEvaluation value
)

Adds a new FieldUniformityEvaluation element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearFieldUniformityEvaluation_List

public void clearFieldUniformityEvaluation_List()

Clear the list of FieldUniformityEvaluation.

No description available in the XSD standard.

function setOpticalCalibrationStandardGroup_List

public void setOpticalCalibrationStandardGroup_List(
    OpticalCalibrationStandard_TypeVector value
)

Sets the list of OpticalCalibrationStandardGroup elements.

Parameters:

value The new list of OpticalCalibrationStandardGroup elements

No description available in the XSD standard.

function getOpticalCalibrationStandardGroup_List

public OpticalCalibrationStandard_TypeVector getOpticalCalibrationStandardGroup_List()

Returns the list of OpticalCalibrationStandardGroup elements.

Return: The list of OpticalCalibrationStandardGroup elements

No description available in the XSD standard.

function addToOpticalCalibrationStandardGroup_List

public void addToOpticalCalibrationStandardGroup_List(
    OpticalCalibrationStandard_Type value
)

Adds a new OpticalCalibrationStandardGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearOpticalCalibrationStandardGroup_List

public void clearOpticalCalibrationStandardGroup_List()

Clear the list of OpticalCalibrationStandardGroup.

No description available in the XSD standard.

function setCalibrationSoftware_List

public void setCalibrationSoftware_List(
    CalibrationSoftwareVector value
)

Sets the list of CalibrationSoftware elements.

Parameters:

value The new list of CalibrationSoftware elements

No description available in the XSD standard.

function getCalibrationSoftware_List

public CalibrationSoftwareVector getCalibrationSoftware_List()

Returns the list of CalibrationSoftware elements.

Return: The list of CalibrationSoftware elements

No description available in the XSD standard.

function addToCalibrationSoftware_List

public void addToCalibrationSoftware_List(
    CalibrationSoftware value
)

Adds a new CalibrationSoftware element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearCalibrationSoftware_List

public void clearCalibrationSoftware_List()

Clear the list of CalibrationSoftware.

No description available in the XSD standard.

function setAnnotationRef

public void setAnnotationRef(
    OpticalCalibration_InlineAnnotationRef value
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef

public OpticalCalibration_InlineAnnotationRef getAnnotationRef()

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef

public void resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

function hasAnnotationRef

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

Return: true if the optional attribute has been set, false otherwise

This is a simple multi-line comment or annotation describing this component.

function __internal_create

public static OpticalCalibration __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function OpticalCalibration

protected OpticalCalibration(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    OpticalCalibration obj
)

Updated on 2026-02-13 at 16:11:05 +0100